feat(releases): adding correct confirmation dialog to archive release flow #7827

jordanl17 · 2024-11-18T05:39:31Z

Description

The current flow for archiving, although correctly using the server action, was not implementing the correct UX.
Now, archiving brings up the correct confirmation dialog.
Unarchiving has also been no-op-ed as the action doesn't exist right now

What to review

Basic update to handle success and error toast in https://github.com/sanity-io/sanity/pull/7827/files#diff-1caef11f0b14726816eda404f88e59a0ca12f88cda6072aca5067e5cc6c03457
Full update to mocking and tests for https://github.com/sanity-io/sanity/pull/7827/files#diff-d6776628bbe3806e444618ea280f59cf6c32cc1ff1229ef931158f670eb4f0c8

Specifically, looking for thoughts on:

Creation of a vite mock object for the export of useReleaseOperations - https://github.com/sanity-io/sanity/pull/7827/files#diff-4aa171c7928a5161b60dde60a11cd53762cc08c16e27a114558f6da103cacb03
A single release fixture for use in the ReleaseMenuButton.test suite - https://github.com/sanity-io/sanity/pull/7827/files#diff-49a11b1a7f4b6c7f99fadf3b5161e16b71d6aea1af3afe1d1e5d25a58513aa54

Interested to know thoughts both on directory structure for these mocks and fixtures, and the naming convention for these files also. Further thoughts:

Separating mocks (eg vi.mock usage for export mocks) and fixtures (objects and other primitives that can be used consistently across all our tests)
mocks sit alongside the files they are mocking the shape of; fixtures sit inside the domain space they are related to
mocks can still be overridden on test by test to customise
fixtures are explicit and exact - they can be spread as necessary, but don't implement factory or builder patterns choosing to just plain JS objects instead

Testing

Note testing thoughts above

Notes for release

N/A

… flow

vercel · 2024-11-18T05:39:34Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 18, 2024 4:29pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 18, 2024 4:29pm
test-compiled-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 18, 2024 4:29pm
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 18, 2024 4:29pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 18, 2024 4:29pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Nov 18, 2024 4:29pm

github-actions · 2024-11-18T05:42:47Z

No changes to documentation

github-actions · 2024-11-18T05:48:30Z

Component Testing Report Updated Nov 18, 2024 4:28 PM (UTC)

✅ All Tests Passed -- expand for details

File	Status	Duration	Passed	Skipped
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 10s	15	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	13s	3	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	40s	6	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	55s	11	7
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	26s	6	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	16s	3	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	✅ Passed (Inspect)	2m 33s	1	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 10s	15	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	2m 39s	21	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 45s	18	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	13s	3	9
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	40s	9	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	28s	6	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	55s	12	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3

github-actions · 2024-11-18T05:51:13Z

⚡️ Editor Performance Report

Updated Mon, 18 Nov 2024 16:29:53 GMT

Benchmark	reference ^{latency of sanity@latest}	experiment ^{latency of this branch}	Δ (%) ^{latency difference}
article (title)	17.5 efps (57ms)	12.6 efps (80ms)	+23ms (+39.5%)	🔴
article (body)	56.2 efps (18ms)	56.7 efps (18ms)	-0ms (-0.8%)	✅
article (string inside object)	17.9 efps (56ms)	13.5 efps (74ms)	+18ms (+32.1%)	🔴
article (string inside array)	15.9 efps (63ms)	11.4 efps (88ms)	+25ms (+39.7%)	🔴
recipe (name)	32.3 efps (31ms)	20.4 efps (49ms)	+18ms (+58.1%)	🔴
recipe (description)	35.7 efps (28ms)	21.3 efps (47ms)	+19ms (+67.9%)	🔴
recipe (instructions)	99.9+ efps (6ms)	99.9+ efps (6ms)	+0ms (-/-%)	✅
synthetic (title)	13.7 efps (73ms)	5.8 efps (174ms)	+101ms (+137.7%)	🔴
synthetic (string inside object)	14.5 efps (69ms)	5.9 efps (169ms)	+100ms (+144.2%)	🔴

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	57ms	60ms	65ms	231ms	449ms	13.3s
article (body)	18ms	21ms	25ms	251ms	457ms	6.1s
article (string inside object)	56ms	60ms	70ms	216ms	480ms	8.9s
article (string inside array)	63ms	68ms	75ms	160ms	879ms	9.5s
recipe (name)	31ms	33ms	37ms	65ms	12ms	8.3s
recipe (description)	28ms	30ms	32ms	44ms	0ms	5.7s
recipe (instructions)	6ms	8ms	8ms	10ms	0ms	3.1s
synthetic (title)	73ms	75ms	82ms	158ms	1186ms	15.4s
synthetic (string inside object)	69ms	72ms	86ms	550ms	2188ms	11.0s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	80ms	85ms	105ms	357ms	3052ms	17.0s
article (body)	18ms	23ms	40ms	275ms	528ms	6.1s
article (string inside object)	74ms	78ms	84ms	423ms	2470ms	11.5s
article (string inside array)	88ms	92ms	96ms	484ms	3339ms	12.2s
recipe (name)	49ms	52ms	71ms	124ms	879ms	10.6s
recipe (description)	47ms	49ms	58ms	165ms	730ms	8.1s
recipe (instructions)	6ms	8ms	8ms	19ms	0ms	3.2s
synthetic (title)	174ms	184ms	225ms	842ms	10716ms	27.7s
synthetic (string inside object)	169ms	177ms	187ms	859ms	9343ms	20.5s

📚 Glossary

column definitions

benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".

latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.

p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.

p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.

p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.

blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.

test duration — how long the test run took to complete.

…/sanity into corel-255-archive-confirmation

jordanl17 · 2024-11-18T11:08:15Z

packages/sanity/src/core/releases/__fixtures__/release.fixture.ts

@@ -0,0 +1,17 @@
+import {type ReleaseDocument} from '../store/types'
+
+export const activeScheduledRelease: ReleaseDocument = {


Thinking that we'd continue to create others here eg activeASAPRelease as are necessary for test cases across our suite. All fixtures would be correct and valid states, eg activeASAPRelease would not have an intendedPublishAt since that is not a valid state machine value

jordanl17 · 2024-11-18T11:09:32Z

...ity/src/core/releases/tool/components/ReleaseMenuButton/__tests__/ReleaseMenuButton.test.tsx

-vi.mock('sanity', () => ({
-  SANITY_VERSION: '0.0.0',
-  useTranslation: vi.fn().mockReturnValue({t: vi.fn()}),
+vi.mock('../../../../store/useReleaseOperations', () => ({


Tried in vain to simplify the way this could be mocked, but a mixture of issues an nuance with how vi.mock is hoisted and executed mean we still need these mock statements explicitly in our tests rather than in generalised mock files

RitaDias · 2024-11-18T12:12:17Z

packages/sanity/src/core/releases/__fixtures__/release.fixture.ts

nice nice nice nice

RitaDias

I rogue thought I had when I was reviewing this related to where wea re placing the fixtures.
I think it might make better sense to keep them somewhere along like we do with the TestProvider in the test directory?

Right now we are keeping in the core/releases but I feel it will come a point where we might want to use releases in other places for one reason or another. Especially since this does kinda touch more parts than this self contained part (the first thing that comes to mind right now are some components in structure).

I'm not married to the idea but I think findability might be better :)

RitaDias · 2024-11-18T12:19:08Z

packages/sanity/src/core/releases/tool/components/ReleaseMenuButton/ReleaseMenuButton.tsx

+          </Text>
+        ),
+      })
+      console.error(archivingError)


Rogue console log or meant to be here? :)

I followed similar approach to what we do in Publish and schedule, so this is intended

RitaDias · 2024-11-18T12:19:36Z

packages/sanity/src/core/releases/tool/components/ReleaseMenuButton/ReleaseMenuButton.tsx

@@ -67,6 +150,8 @@ export const ReleaseMenuButton = ({disabled, release}: ReleaseMenuButtonProps) =
            {!release?.state || release.state === 'archived' ? (
              <MenuItem
                onClick={handleUnarchive}
+                // TODO: disabled as CL action not yet impl


Do we have a linear story for this? 👀

Yes we do corel-256

RitaDias

Just a few comments and a suggestion, great job :)

packages/sanity/src/core/releases/store/createReleaseOperationStore.ts

bjoerge · 2024-11-18T13:27:14Z

packages/sanity/src/core/releases/tool/components/ReleaseMenuButton/ReleaseMenuButton.tsx

-    telemetry.log(UnarchivedRelease)
-    setIsPerformingOperation(false)
+    // noop
+    // TODO: similar to handleArchive - complete once server action exists


what's the reason for deleting this? Do we expect unarchive to change significantly?

It will change from what it currently is in corel (will be updated to to be similar to archive). I considered implementing it, but feel it's better to complete the full task once the action can be test alongside. There's a separate task I'm monitoring and will complete once ready

packages/sanity/src/core/releases/tool/components/ReleaseMenuButton/ReleaseMenuButton.tsx

bjoerge · 2024-11-18T13:32:36Z

packages/sanity/src/core/releases/store/__tests__/__mocks/useReleaseOperations.mock.ts

+
+import {type ReleaseOperationsStore} from '../../createReleaseOperationStore'
+
+export const useReleaseOperationsMock: Mocked<ReleaseOperationsStore> = {


This looks like a great pattern to me!

bjoerge

Nice work!

jordanl17 added 2 commits November 18, 2024 03:04

feat(releases): adding correct confirmation dialog to archive release…

14c8d7b

… flow

test(releases): testing archive release action

ca8361b

Merge branch 'corel' into corel-255-archive-confirmation

2e5a153

vercel bot deployed to Preview – performance-studio November 18, 2024 05:43 View deployment

vercel bot deployed to Preview – page-building-studio November 18, 2024 05:43 View deployment

vercel bot deployed to Preview – test-studio November 18, 2024 05:44 View deployment

vercel bot deployed to Preview – test-next-studio November 18, 2024 05:49 View deployment

vercel bot deployed to Preview – test-compiled-studio November 18, 2024 05:52 View deployment

jordanl17 added 2 commits November 18, 2024 10:49

test(releases): fixtures for release added for use in ReleaseMenuButton

2459a6f

Merge branch 'corel-255-archive-confirmation' of github.com:sanity-io…

41196cf

…/sanity into corel-255-archive-confirmation

vercel bot deployed to Preview – test-studio November 18, 2024 10:58 View deployment

vercel bot deployed to Preview – performance-studio November 18, 2024 10:58 View deployment

vercel bot deployed to Preview – page-building-studio November 18, 2024 10:58 View deployment

vercel bot deployed to Preview – test-next-studio November 18, 2024 11:01 View deployment

vercel bot deployed to Preview – test-compiled-studio November 18, 2024 11:02 View deployment

jordanl17 requested review from bjoerge, juice49, RitaDias and pedrobonamin November 18, 2024 11:06

jordanl17 commented Nov 18, 2024

View reviewed changes

jordanl17 marked this pull request as ready for review November 18, 2024 11:09

jordanl17 requested a review from a team as a code owner November 18, 2024 11:09

RitaDias reviewed Nov 18, 2024

View reviewed changes

packages/sanity/src/core/releases/__fixtures__/release.fixture.ts

Copy link

Contributor

RitaDias Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice nice nice nice

jordanl17 reacted with heart emoji

RitaDias reviewed Nov 18, 2024

View reviewed changes

RitaDias approved these changes Nov 18, 2024

View reviewed changes

bjoerge requested changes Nov 18, 2024

View reviewed changes

test(releases): mocking of useBundleDocuments

d419899

vercel bot deployed to Preview – page-building-studio November 18, 2024 16:22 View deployment

vercel bot deployed to Preview – performance-studio November 18, 2024 16:23 View deployment

vercel bot deployed to Preview – test-studio November 18, 2024 16:24 View deployment

vercel bot deployed to Preview – test-next-studio November 18, 2024 16:27 View deployment

vercel bot deployed to Preview – test-compiled-studio November 18, 2024 16:29 View deployment

jordanl17 requested review from bjoerge and RitaDias November 18, 2024 16:36

bjoerge approved these changes Nov 18, 2024

View reviewed changes

jordanl17 merged commit 474bfba into corel Nov 18, 2024
56 of 58 checks passed

jordanl17 deleted the corel-255-archive-confirmation branch November 18, 2024 17:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(releases): adding correct confirmation dialog to archive release flow #7827

feat(releases): adding correct confirmation dialog to archive release flow #7827

jordanl17 commented Nov 18, 2024 •

edited

Loading

vercel bot commented Nov 18, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024

github-actions bot commented Nov 18, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024 •

edited

Loading

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

jordanl17 Nov 18, 2024

RitaDias Nov 18, 2024

jordanl17 Nov 18, 2024

RitaDias Nov 18, 2024

RitaDias left a comment

RitaDias Nov 18, 2024

jordanl17 Nov 18, 2024

RitaDias Nov 18, 2024

jordanl17 Nov 18, 2024

RitaDias left a comment

bjoerge Nov 18, 2024

jordanl17 Nov 18, 2024

bjoerge Nov 18, 2024

bjoerge left a comment

		@@ -0,0 +1,17 @@
		import {type ReleaseDocument} from '../store/types'

		export const activeScheduledRelease: ReleaseDocument = {


		import {type ReleaseOperationsStore} from '../../createReleaseOperationStore'

		export const useReleaseOperationsMock: Mocked<ReleaseOperationsStore> = {

feat(releases): adding correct confirmation dialog to archive release flow #7827

feat(releases): adding correct confirmation dialog to archive release flow #7827

Conversation

jordanl17 commented Nov 18, 2024 • edited Loading

Description

What to review

Testing

Notes for release

vercel bot commented Nov 18, 2024 • edited Loading

github-actions bot commented Nov 18, 2024

github-actions bot commented Nov 18, 2024 • edited Loading

github-actions bot commented Nov 18, 2024 • edited Loading

⚡️ Editor Performance Report

🏠 Reference result

🧪 Experiment result

📚 Glossary

column definitions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RitaDias left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RitaDias left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bjoerge left a comment

Choose a reason for hiding this comment

jordanl17 commented Nov 18, 2024 •

edited

Loading

vercel bot commented Nov 18, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024 •

edited

Loading

github-actions bot commented Nov 18, 2024 •

edited

Loading